
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>create-http-lb-config</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>create-http-lb-config</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="create-http-lb.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-http-lb-ref.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="create-http-lb-config-1"></a><a id="GSRFM00028"></a><a id="create-http-lb-config"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_create_http_lb_config">create-http-lb-config</h2>
<div class="sectionbody">
<div class="paragraph">
<p>creates a configuration for the load balancer</p>
</div>
<div id="sthref251" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] create-http-lb-config [--help]
[--responsetimeout 60]
[httpsrouting=false] [--reloadinterval 60]
[--monitor=false] [--property (name=value)[:name=value]*]
--target target | config_name</code></pre>
</div>
</div>
<div id="sthref252" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>Use the <code>create-http-lb-config</code> subcommand to create a load balancer
configuration. This configuration applies to load balancing in the HTTP
path. After using this subcommand to create the load balancer
configuration file, create the load balancer by running
<code>create-http-lb</code>.</p>
</div>
<div class="paragraph">
<p>You must specify either a target or a configuration name, or both. If
you do not specify a target, the configuration is created without a
target and you add one later using <code>create-http-lb-ref</code>. If you don&#8217;t
specify a configuration name, a name is created based on the target
name. If you specify both, the configuration is created with the
specified name, referencing the specified target.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph">
<p>This subcommand is only applicable to Oracle Payara Server. This
subcommand is not applicable to Payara Server Open Source Edition.</p>
</div>
</td>
</tr>
</table>
</div>
<div id="sthref253" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--responsetimeout</code></dt>
<dd>
<p>The time in seconds within which a server instance must return a
response. If no response is received within the time period, the
server is considered unhealthy. If set to a positive number, and the
request is idempotent, the request is retried. If the request is not
idempotent, an error page is returned. If set to 0 no timeout is used.
The default is 60.</p>
</dd>
<dt class="hdlist1"><code>--httpsrouting</code></dt>
<dd>
<p>If set to <code>true</code>, HTTPS requests to the load balancer result in HTTPS
requests to the server instance. If set to <code>false</code>, HTTPS requests to
the load balancer result in HTTP requests to the server instance. The
default is <code>false</code>.</p>
</dd>
<dt class="hdlist1"><code>--reloadinterval</code></dt>
<dd>
<p>The interval between checks for changes to the load balancer
configuration file <code>loadbalancer.xml</code>. When the check detects changes,
the configuration file is reloaded. A value of <code>0</code> disables reloading.</p>
</dd>
<dt class="hdlist1"><code>--monitor</code></dt>
<dd>
<p>Specifies whether monitoring is enabled. The default is <code>false</code>.</p>
</dd>
<dt class="hdlist1"><code>--routecookie</code></dt>
<dd>
<p>This option is deprecated. The value is always <code>true</code>.</p>
</dd>
<dt class="hdlist1"><code>--property</code></dt>
<dd>
<p>Optional attribute name/value pairs for configuring the load balancer.</p>
</dd>
<dt class="hdlist1"><code>--target</code></dt>
<dd>
<p>Specifies the target to which the load balancer configuration applies.
If you don&#8217;t specify a target, the load balancer configuration is
created without a target. You can specify targets later using the
subcommand <code>create-http-lb-ref</code>.<br>
Valid values are:<br></p>
<div class="ulist">
<ul>
<li>
<p>cluster_name- Specifies that requests for this cluster will be
handled by the load balancer.</p>
</li>
<li>
<p>stand-alone_instance_name- Specifies that requests for this
standalone instance will be handled by the load balancer.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<div id="sthref254" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">config_name</dt>
<dd>
<p>The name of the new load balancer configuration. This name must not
conflict with any other load balancer groups, agents, configurations,
clusters, or sever instances in the domain. If you don&#8217;t specify a
name, the load balancer configuration name is based on the target
name, target_name`-http-lb-config`.</p>
</dd>
</dl>
</div>
<div id="sthref255" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM479"></a><a id="sthref256"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Creating a Load Balancer Configuration</p>
</div>
<div class="paragraph">
<p>This example creates a load balancer configuration on a target named
<code>mycluster</code> and load balancer configuration named <code>mylbconfigname</code>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; create-http-lb-config --target mycluster mylbconfigname

Command create-http-lb-config executed successfully.</code></pre>
</div>
</div>
<div id="sthref257" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>subcommand executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the subcommand</p>
</dd>
</dl>
</div>
<div id="sthref258" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="delete-http-lb-config.html#delete-http-lb-config-1"><code>delete-http-lb-config</code>(1)</a>,
<a href="list-http-lb-configs.html#list-http-lb-configs-1"><code>list-http-lb-configs</code>(1)</a>,
<a href="create-http-lb.html#create-http-lb-1"><code>create-http-lb</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="create-http-lb.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-http-lb-ref.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
